home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / cleanup.arc / CLEANUP.DOC next >
Text File  |  1987-08-27  |  10KB  |  274 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                   CLEANUP
  10.                                (Version 1.1)
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                      The Disk Garbage Cleanup Manager
  17.  
  18.  
  19.  
  20.                              The SoftTouch
  21.  
  22.  
  23.                             Copyright 1987
  24.  
  25.  
  26.  
  27.  
  28.  
  29.      TABLE OF CONTENTS
  30.  
  31.  
  32.           Introduction.......................................3
  33.  
  34.           User's Rights to Copy..............................4
  35.  
  36.           Installation.......................................5
  37.  
  38.           Main Windows and Main Menu.........................6
  39.  
  40.             - Specifying Files to Cleanup....................6
  41.  
  42.             - Displaying Status..............................7
  43.  
  44.             - Printing Statistics............................7
  45.  
  46.             - Getting Online Help............................7
  47.  
  48.             - Configuring....................................7
  49.  
  50.             - Misc. Tools....................................8
  51.  
  52.             - Terminating....................................8
  53.  
  54.  
  55.  
  56.      INTRODUCTION
  57.  
  58.  
  59. Nearly every package, program, and utility creates temporary files which 
  60. can accumulate on your disks (floppy and/or hard) taking up precious space.  
  61. While the task of deleting these files is at best tedious on a floppy disk, 
  62. it is almost impossible on a hard disk which may have many directories and 
  63. sub-directories.  CLEANUP helps you manage these unwanted files.
  64.  
  65. There are many "cleanup" routines on the market, both public and 
  66. commercial; however, CLEANUP (by The SoftTouch) is unique.  CLEANUP allows 
  67. you to do more than delete a specific file or group of related files.  
  68. CLEANUP allows you to define all of the files you wish to remove and will 
  69. remove them for you "at the touch of a button".  CLEANUP allows you to 
  70. define up to 100 different files, using all of the standard DOS wild cards.  
  71. It will then search your entire disk, regardless of the number or level of 
  72. sub-directories, removing all of your unwanted files, freeing up precious, 
  73. expensive space.
  74.  
  75. CLEANUP provides you with a very "user-friendly" environment consisting of 
  76. pull-down windows, complete control of all directories and files, and 
  77. detailed statistics of the cleanup process.  If you are tired of running 
  78. out of space and/or deleting the mass of temporary files which can 
  79. accumulate on your disks, try CLEANUP.
  80.  
  81.  
  82.  
  83.      USER'S RIGHTS TO COPY
  84.  
  85.  
  86. As a PC User you have the right to copy, without charge, CLEANUP.  If you 
  87. are a corporation or business a donation of $30 is suggested to enable The 
  88. SoftTouch to continue to develop quality products.
  89.  
  90. Given the above clause, you are free to copy and distribute this package 
  91. provided:
  92.  
  93.           - This program is not distributed in modified form
  94.           - No fee or consideration is charged for copies
  95.           - The Userware/Freeware notice is not bypassed
  96.           - You believe in the Userware/Freeware concept
  97.           - The minimum files which must be distributed are:
  98.                     CLEANUP.EXE
  99.                     CLEANUP.DOC
  100.  
  101.  
  102. If you wish to make a contribution mail it to:
  103.  
  104.                              The SoftTouch
  105.                              c/o Bob Patten
  106.                            7922 Corder Drive
  107.                           Charlotte, NC 28212
  108.  
  109. If you encounter problems, wish to suggest enhancements, or wish to obtain 
  110. a list of other software available from The SoftTouch, please feel free to 
  111. write; I will be glad to hear from you.  I will be actively supporting any 
  112. SoftTouch product on the following Bulletin Boards:
  113.  
  114.                The BOSS            (201) 568-7293
  115.                Software Society    (201) 729-7410
  116.  
  117. If you wish to contact me (other than writing) please leave a message on 
  118. either board.
  119.  
  120.  
  121.  
  122.  
  123. The SoftTouch in no way accepts responsibility for your use, misuse, or 
  124. inability to use this or any other SoftTouch package.
  125.  
  126.  
  127. Regardless of contribution, enjoy and use CLEANUP.  It will make your life 
  128. a lot easier.
  129.  
  130.  
  131.  
  132.      INSTALLATION
  133.  
  134. To install CLEANUP simply copy files mentioned in the "User's Right to 
  135. Copy" section.  
  136.  
  137. CLEANUP will create a CLEANUP.SYS file the first time you use it.  This 
  138. file will contain the files you wish to be deleted.  This file should not 
  139. be deleted once configured to your needs, since the default file set will 
  140. be used if it does not exist.
  141.  
  142. CLEANUP may also create a CLEANUP.LST file if you request a printing of the 
  143. statistics of a run.  This file can be considered temporary and can be 
  144. deleted after you print it.
  145.  
  146. Both of these files created by CLEANUP are placed in the root directory.
  147.  
  148.  
  149.      MAIN SCREEN DISPLAY and MAIN MENU
  150.  
  151.  
  152. The main screen is composed of several different windows.
  153.  
  154. The first is the main menu window across the top of the screen.  This is 
  155. where all options are requested.  This main menu contains the following 
  156. options:
  157.  
  158.           CLEANUP        - run the cleanup procedure
  159.           FILES          - specify files to delete (sub-window)
  160.           DISPLAY        - control the deletion of files, selection of
  161.                                    directories, and display of deleted
  162.                                    files (sub-window)
  163.           PRINT          - choose a printable report file to be produced
  164.           HELP           - online help (sub-window)
  165.           SETUP          - configuration (ie: page size...) (sub-window)
  166.           TOOLS          - misc tools (ie: DOS subtask...) (sub-window)
  167.           QUIT           - terminate current session
  168.  
  169. In the second window the directories are searched and files which are 
  170. deleted will be displayed.
  171.  
  172. The next window is a statistics window which will display the current 
  173. runtime statistics.  Such statistics as; current drive, number of files 
  174. deleted, number of directories searched, space free, percent disk free, 
  175. runtime seconds, etc.
  176.  
  177. At the bottom of the screen there are two single line windows.  One of them 
  178. is used to display error or information type messages.  The other displays 
  179. the status of the print, display, and/or prompt options.
  180.  
  181. To actually perform the cleanup operation simply select the CLEANUP option 
  182. from the main menu.
  183.  
  184.  
  185.  
  186.      SPECIFYING FILES TO CLEANUP
  187.  
  188. CLEANUP comes with a default set of files to delete.  These can be used, 
  189. added to, or deleted and replaced entirely.  To do so simply position the 
  190. cursor to the FILES main menu option and press return.  This will cause an 
  191. overlay window to be displayed in which you can edit the files to be 
  192. deleted.  Up to 100 different files can be deleted at once.  Standard DOS 
  193. wild cards ('*' and '?') are completely valid.  
  194.  
  195.  
  196.  
  197. Use the page up and down keys to move a page of files at a time or use the 
  198. cursor up and down to scroll through a file at a time.  In addition:
  199.  
  200.           ESC       - from editing a file name will terminate
  201.                          without modifying.  
  202.           ESC       - from file selection will remove the files window
  203.           INS       - from file selection will insert a file to delete
  204.           DEL       - from file selection will delete the current file
  205.  
  206. Otherwise, standard editing capabilities are available.
  207.  
  208.  
  209.  
  210.      DISPLAY STATUS
  211.  
  212.  
  213. CLEANUP allows you to control every directory and file, if you so wish.  To 
  214. select these options use the DISPLAY main menu option.  This will display 
  215. an overlay window which contains the options: DISPLAY, DIR PROMPT, and FILE 
  216. PROMPT.  The usage of these selections are as follows;
  217.  
  218.           DISPLAY        - displays every file (name) as it is deleted
  219.           DIR PROMPT     - prompts you for cleanup of every directory
  220.           FILE PROMPT    - prompts you for deletion of every file.
  221.                            NOTE: this can be the cause of a long runtime.
  222.  
  223. As you select an option a toggle is displayed on the bottom line indicating 
  224. whether the option is "on" or "off".  Note: The default is off; therefore, 
  225. the only thing displayed is the directories as they are processed.
  226.  
  227.  
  228.  
  229.      PRINTING STATISTICS
  230.  
  231. CLEANUP gives you the ability to print a complete detail of the session.  
  232. To choose this option use the PRINT option from the main menu.  Note: a 
  233. toggle will appear on the last line indicating the status of this option 
  234. (the default is no printing).  The PRINT option will generate a printable 
  235. file which contains the directory searched, whether a search was allowed 
  236. (if in directory prompt mode), the file type deleted (as specified with 
  237. wild cards), and the number of files of this type.  This is done on a 
  238. directory by directory basis.  At the completion of the cleanup process, 
  239. CLEANUP will print the number of files deleted, number of directories 
  240. searched, disk space used (Kb), disk space freed (b), disk space free (Kb), 
  241. percent free, and total runtime of the current session (seconds).
  242.  
  243.  
  244.      GETTING ONLINE HELP
  245.  
  246. Use the main menu HELP option for online help which provides a brief 
  247. overview about each option.  Note: ESC will terminate help while any other 
  248. key will indicate to continue displaying help.
  249.  
  250.  
  251.      CONFIGURING
  252.  
  253. To configure CLEANUP to your needs and preferences use the option SETUP.  
  254. You are allowed to specify: always prompt by directory, always prompt by 
  255. file, save the current files as permanent, set the page size of the 
  256. printable file.  An overlayed window will be displayed allowing you to 
  257. select any of the above sub-options.  In the case of page size an 
  258. additional window will be overlayed which will allow you to enter the page 
  259. size.  Note: minimum = 1 and maximum = 100.
  260.  
  261.  
  262.      MISC. TOOLS
  263.  
  264. In order to allow more freedom, CLEANUP provides several tools (see the 
  265. TOOLS option).  The current tools are: a DOS subtask and the ability to 
  266. switch drives.  A window will be displayed allowing either selection, and 
  267. if changing drives, will prompt for the new drive.
  268.  
  269.      QUIT
  270.  
  271. The final option in CLEANUP is QUIT.  This will terminate the current 
  272. session and return to to DOS.
  273.  
  274.